/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.hedwig.filter;

import java.io.IOException;

import org.apache.commons.configuration.Configuration;
import org.apache.commons.configuration.ConfigurationException;

/**
 * Message Filter running in server-side. Hub server uses reflection to
 * instantiate a message filter to filter messages.
 */
public interface ServerMessageFilter extends MessageFilterBase {

    /**
     * Initialize the message filter.
     *
     * @param conf
     *          Configuration Object. An <i>MessageFilter</i> might read settings from it.
     * @return message filter
     * @throws IOException when failed to initialize message filter
     */
    public ServerMessageFilter initialize(Configuration conf)
    throws ConfigurationException, IOException;

    /**
     * Uninitialize the message filter.
     */
    public void uninitialize();

}
